package traveler;


/**
 * The Traveler class is the low level object which represents an individual 
 * person travelling within this simulation. 
 * 
 * @author Team Switchboard Boxcar
 *
 */
public class Traveler 
{
	private int Destination; 	// This needs to be changed to type Neighborhood
	private int DepartureTime;
	
	/**
	 * Traveler (0 Inputs) is the basic constructor for the Traveler Class. This
	 * function sets Destination adn DepatureTime to imaginary values for future
	 * traceability
	 * 
	 */
	public Traveler()
	{
		Destination = -1;
		DepartureTime = -1;
	}
	
	/**
	 * Traveler (2 Inputs) is the advanced contructor for the Traveler Class.
	 * This function allows the Destination and DepartureTime to be sent to the
	 * input values.
	 * 
	 * @param MyDestination
	 *            Input Neighborhood that a Traveler needs to go to. Cannot be
	 *            the starting neighborhood.
	 * @param MyTime
	 *            Time that the Traveler begins the trip for future statistics.
	 */
	public Traveler(int MyDestination, int MyTime) 
	{
		Destination = MyDestination;
		DepartureTime = MyTime;
	}
	
	/**
	 * SetDepatureTime allows the system to update the time a traveler began
	 * their trip.
	 * 
	 * @param MyTime
	 *            User inputs Time Value to update Traveler
	 */
	public void SetDepartTime(int MyTime)
	{ 	DepartureTime = MyTime;	}
	
	/**
	 * GetTotalTime returns the DepartureTime of the Traveler.
	 * 
	 * @return DepartureTime Returns the time that the Traveler's journey began.
	 */	
	public int GetTotalTime()	// Return's Total Time (CurrentTime - DepartureTime)?  
	{	return DepartureTime;}	// Or just Departure Time?
	
	/**
	 * GetDestination returns the Neighborhood destination of a Traveler
	 * @return Destination Returns a Neighborhood
	 */
	public int GetDestination() // Need to update from int to Neighborhood
	{ return Destination;}
	
	
}